Skip to content

Add a full example configuration to the README#122

Open
SOC-SE wants to merge 2 commits intodbaseqp:mainfrom
SOC-SE:main
Open

Add a full example configuration to the README#122
SOC-SE wants to merge 2 commits intodbaseqp:mainfrom
SOC-SE:main

Conversation

@SOC-SE
Copy link

@SOC-SE SOC-SE commented Jan 27, 2026

This PR adds the exact configuration I used for SEMO's Invitational, although passwords were omitted.

@tire-fire
Copy link
Contributor

Thanks for the submission. Does this make sense to include in the README? There's already an example config file, which I think could use some further examples like you have here instead.

@SOC-SE
Copy link
Author

SOC-SE commented Jan 30, 2026

Thanks for the submission. Does this make sense to include in the README? There's already an example config file, which I think could use some further examples like you have here instead.

I was asked by Wasabi and baseq to submit my configuration as a PR to give an additional example. I wasn't told to piece it out into individual examples. If you want the current README to do without it, I can split it up into the individual components as an alternative.

I think it's worth noting that while individual sections are explained by the README, there is no full example, which is what I'm trying to provide. As someone who was learning how to setup Quotient with no prior experience or development with it, I found the lack of a complete example to be frustrating. It's not explicit how the complete configuration or order of the sections should look.

@tire-fire
Copy link
Contributor

We do have an example config here: https://github.com/dbaseqp/Quotient/blob/main/config/event.conf.example but I think you're right that it's not a full working one. I'll add all the required sections to it and update it based on your submission.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants